
<!DOCTYPE html>
<!--

    Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.

    This program and the accompanying materials are made available under the
    terms of the Eclipse Public License v. 2.0, which is available at
    http://www.eclipse.org/legal/epl-2.0.

    This Source Code may also be made available under the following Secondary
    Licenses when the conditions for such availability set forth in the
    Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
    version 2 with the GNU Classpath Exception, which is available at
    https://www.gnu.org/software/classpath/license.html.

    SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0

-->
<!-- Portions Copyright [2019] [Payara Foundation and/or its affiliates] -->
<html lang="en">
  <head>
    <meta charset="utf-8"/>
    <title>create-node-ssh</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link href="css/style.css" rel="stylesheet">
    <script src="https://use.fontawesome.com/96c4d89611.js"></script>
  </head>
  <body>
<table id="doc-title" cellspacing="0" cellpadding="0">
  <tr>
  <td align="left" valign="top">
  <b>create-node-ssh</b><br />
  </td>
  </tr>
</table>
<hr />

<table width="90%" id="top-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>
		<td align="left">
		<a href="create-node-dcom.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-password-alias.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class=" vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>


<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p><a id="create-node-ssh-1"></a><a id="GSRFM00048"></a><a id="create-node-ssh"></a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_create_node_ssh">create-node-ssh</h2>
<div class="sectionbody">
<div class="paragraph">
<p>creates a node that is enabled for communication over SSH</p>
</div>
<div id="sthref463" class="paragraph">
<p>Synopsis</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin [asadmin-options] create-node-ssh [--help]
--nodehost node-host
[--installdir as-install-parent] [--nodedir node-dir]
[--sshport ssh-port] [--sshuser ssh-user]
[--sshkeyfile ssh-keyfile]
[--force={false|true}]
[--install={false|true}] [--archive archive]
node-name</code></pre>
</div>
</div>
<div id="sthref464" class="paragraph">
<p>Description</p>
</div>
<div class="paragraph">
<p>The <code>create-node-ssh</code> subcommand creates a node that is enabled for
communication over secure shell (SSH).</p>
</div>
<div class="paragraph">
<p>A node represents a host on which the \{product---name} software is
installed. A node must exist for every host on which \{product---name}
instances reside.</p>
</div>
<div class="paragraph">
<p>The domain administration server (DAS) contacts an SSH node&#8217;s host
through the SSH connector to manage \{product---name} instances that
reside on the node. However, the DAS does not use the SSH connector to
contact the host where the DAS is running because the DAS can run all
<code>asadmin</code> subcommands locally.</p>
</div>
<div class="paragraph">
<p>By default, the subcommand fails and the node is not created if the DAS
cannot contact the node&#8217;s host through SSH. To force the node to be
created in the DAS configuration even if the host cannot be contacted
through SSH, set the <code>--force</code> option to <code>true</code>.</p>
</div>
<div class="paragraph">
<p>This subcommand is supported in remote mode only.</p>
</div>
<div id="sthref465" class="paragraph">
<p>Options</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">asadmin-options</dt>
<dd>
<p>Options for the <code>asadmin</code> utility. For information about these
options, see the <a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> help page.</p>
</dd>
<dt class="hdlist1"><code>--help</code></dt>
<dt class="hdlist1"><code>-?</code></dt>
<dd>
<p>Displays the help text for the subcommand.</p>
</dd>
<dt class="hdlist1"><code>--nodehost</code></dt>
<dd>
<p>The name of the host that the node represents. The name of the host
must be specified. Otherwise, an error occurs.</p>
</dd>
<dt class="hdlist1"><code>--installdir</code></dt>
<dd>
<p>The full path to the parent of the base installation directory of the
\{product---name} software on the host, for example,
<code>/export/glassfish3/</code>. The default is the parent of the default base
installation directory of the \{product---name} software for the DAS.
This default is useful only if \{product---name} is installed in the
same location on all hosts.</p>
</dd>
<dt class="hdlist1"><code>--nodedir</code></dt>
<dd>
<p>The path to the directory that is to contain \{product---name}
instances that are created on the node. The default is
as-install`/nodes`, where as-install is the base installation
directory of the \{product---name} software on the host. If a relative
path is specified, the path is relative to the as-install directory.</p>
</dd>
<dt class="hdlist1"><code>--sshport</code></dt>
<dd>
<p>The port to use for SSH connections to this node&#8217;s host. The default
is 22. If the <code>--nodehost</code> option is set to <code>localhost-`domain, the
`--sshport</code> option is ignored.</p>
</dd>
<dt class="hdlist1"><code>--sshuser</code></dt>
<dd>
<p>The user on this node&#8217;s host that is to run the process for connecting
to the host through SSH. The default is the user that is running the
DAS process. To ensure that the DAS can read this user&#8217;s SSH private
key file, specify the user that is running the DAS process. If the
<code>--nodehost</code> option is set to <code>localhost-`domain, the `--sshuser</code>
option is ignored.</p>
</dd>
<dt class="hdlist1"><code>--sshkeyfile</code></dt>
<dd>
<p>The absolute path to the SSH private key file for user that the
<code>--sshuser</code> option specifies. This file is used for authentication to
the <code>sshd</code> daemon on the node&#8217;s host.<br></p>
</dd>
</dl>
</div>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 100%;">
</colgroup>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><div><div class="paragraph">
<p>Note:</p>
</div>
<div class="paragraph">
<p>\{product---name} also supports password authentication through the
<code>AS_ADMIN_SSHPASSWORD</code> entry in the password file. The password file
is specified in the <code>--paswordfile</code> option of the
<a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a> utility.</p>
</div></div></td>
</tr>
</tbody>
</table>
<div class="literalblock">
<div class="content">
<pre>  If the SSH private key file is protected by a passphrase, the password
  file must contain the `AS_ADMIN_SSHKEYPASSPHRASE` entry. +
  The path to the key file must be reachable by the DAS and the key file
  must be readable by the DAS. +
  The default is the a key file in the user's `.ssh` directory. If
  multiple key files are found, the subcommand uses the following order
  of preference: +
  1.  `id_rsa`
  2.  `id_dsa`
  3.  `identity`
`--force`::
  Specifies whether the node is created in the DAS configuration even if
  validation of the node's parameters fails. To validate a node's
  parameters, the DAS must be able to contact the node's host through
  SSH. Possible values are as follows: +
  `false`;;
    The node is not created if validation of the node's parameters fails
    (default).
  `true`;;
    The node is created even if validation of the node's parameters
    fails.
`--install`::
  Specifies whether the subcommand shall install the \{product---name}
  software on the host that the node represents. +
  Possible values are as follows: +
  `false`;;
    The subcommand shall not install the \{product---name} software on
    the host (default).
  `true`;;
    The subcommand shall install the \{product---name} software on the
    host.
`--archive`::
  The absolute path to the archive file of the \{product---name}
  software that is to be installed. If this option is omitted and the
  `--install` is `true`, the subcommand creates a ZIP archive of the
  \{product---name} software from the installation where this subcommand
  is run. The archive does not contain the `domains` directory or the
  `nodes` directory.</pre>
</div>
</div>
<div id="sthref466" class="paragraph">
<p>Operands</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">node-name</dt>
<dd>
<p>The name of the node.<br>
The name must meet the following requirements:<br></p>
<div class="ulist">
<ul>
<li>
<p>The name may contain only ASCII characters.</p>
</li>
<li>
<p>The name must start with a letter, a number, or an underscore.</p>
</li>
<li>
<p>The name may contain only the following characters:</p>
<div class="ulist">
<ul>
<li>
<p>Lowercase letters</p>
</li>
<li>
<p>Uppercase letters</p>
</li>
<li>
<p>Numbers</p>
</li>
<li>
<p>Hyphen</p>
</li>
<li>
<p>Period</p>
</li>
<li>
<p>Underscore</p>
</li>
</ul>
</div>
</li>
<li>
<p>The name must be unique in the domain and must not be the name of
another node, a cluster, a named configuration, or a \{product---name}
instance.</p>
</li>
<li>
<p>The name must not be <code>domain</code>, <code>server</code>, or any other keyword that
is reserved by \{product---name}.</p>
</li>
</ul>
</div>
</dd>
</dl>
</div>
<div id="sthref467" class="paragraph">
<p>Examples</p>
</div>
<div class="paragraph">
<p><a id="GSRFM513"></a><a id="sthref468"></a></p>
</div>
<div class="paragraph">
<p>Example 1   Creating a Node</p>
</div>
<div class="paragraph">
<p>This example creates the node <code>adc</code> for the host <code>adc.example.com</code>. By
default, the parent of the base installation directory of the
\{product---name} software is <code>/export/glassfish3</code>.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; create-node-ssh
--nodehost adc.example.com
--installdir /export/glassfish3 adc

Command create-node-ssh executed successfully.</code></pre>
</div>
</div>
<div class="paragraph">
<p><a id="GSRFM514"></a><a id="sthref469"></a></p>
</div>
<div class="paragraph">
<p>Example 2   Forcing the Creation of a Node</p>
</div>
<div class="paragraph">
<p>This example forces the creation of node <code>eg1</code> for the host
<code>eghost.example.com</code>. The node is created despite the failure of the DAS
to contact the host <code>eghost.example.com</code> to validate the node&#8217;s
parameters.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="prettyprint highlight"><code class="language-oac_no_warn" data-lang="oac_no_warn">asadmin&gt; create-node-ssh --force --nodehost eghost.example.com eg1
Warning: some parameters appear to be invalid.
Could not connect to host eghost.example.com using SSH.
There was a problem while connecting to eghost.example.com:22
eghost.example.com
Continuing with node creation due to use of --force.

Command create-node-ssh executed successfully.</code></pre>
</div>
</div>
<div id="sthref470" class="paragraph">
<p>Exit Status</p>
</div>
<div class="dlist">
<dl>
<dt class="hdlist1">0</dt>
<dd>
<p>command executed successfully</p>
</dd>
<dt class="hdlist1">1</dt>
<dd>
<p>error in executing the command</p>
</dd>
</dl>
</div>
<div id="sthref471" class="paragraph">
<p>See Also</p>
</div>
<div class="paragraph">
<p><a href="asadmin.html#asadmin-1m"><code>asadmin</code>(1M)</a></p>
</div>
<div class="paragraph">
<p><a href="create-node-config.html#create-node-config-1"><code>create-node-config</code>(1)</a>,
<a href="create-node-dcom.html#create-node-dcom-1"><code>create-node-dcom</code>(1)</a>,
<a href="delete-node-ssh.html#delete-node-ssh-1"><code>delete-node-ssh</code>(1)</a>,
<a href="install-node.html#install-node-1"><code>install-node</code>(1)</a>,
<a href="install-node-ssh.html#install-node-ssh-1"><code>install-node-ssh</code>(1)</a>,
<a href="list-nodes.html#list-nodes-1"><code>list-nodes</code>(1)</a>,
<a href="ping-node-ssh.html#ping-node-ssh-1"><code>ping-node-ssh</code>(1)</a>,
<a href="setup-ssh.html#setup-ssh-1"><code>setup-ssh</code>(1)</a>,
<a href="uninstall-node.html#uninstall-node-1"><code>uninstall-node</code>(1)</a>,
<a href="uninstall-node-ssh.html#uninstall-node-ssh-1"><code>uninstall-node-ssh</code>(1)</a>,
<a href="update-node-ssh001.html#update-node-ssh-1"><code>update-node-ssh</code>(1)</a></p>
</div>
</div>
</div>

<hr />

<table width="90%" id="bottom-nav" cellspacing="0" cellpadding="0">
	<colgroup>
		<col width="12%"/>
		<col width="12%"/>
		<col width="*"/>
	</colgroup>
	<tr>		
		<td align="left">
		<a href="create-node-dcom.html">
			<span class=" vector-font"><i class="fa fa-arrow-circle-left" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Previous</span>
		</a>
		</td>

		<td align="left">
		<a href="create-password-alias.html">
			<span class="vector-font"><i class="fa fa-arrow-circle-right vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Next</span>
		</a>
		</td>

		<td align="right">
		<a href="toc.html">
			<span class="vector-font"><i class="fa fa-list vector-font" aria-hidden="true"></i></span>
			<span style="position:relative;top:-2px;">Contents</span>
		</a>
		</td>
	</tr>
</table>

<span id="copyright">
        <img src="/resource/reference/img/eclipse_foundation_logo_tiny.png" height="20px" alt="Eclipse Foundation Logo" align="top"/>&nbsp;            
        <span >Copyright&nbsp;&copy;&nbsp;2019,&nbsp;Oracle&nbsp;and/or&nbsp;its&nbsp;affiliates.&nbsp;All&nbsp;rights&nbsp;reserved.</span>
</span>

</body>
</html>
